Merge requests, commits and branch names

As a department we should standardise our merge requests and commits to give us the most visibility and cross references between tools.

We use a Jira to Gitlab integration [1] which means that you can link your Jira issues to Gitlab commits.

We also use a Semantic Release [2][3] in many projects to give you an automated changelog from your commits.

Together, these should enhance your developer experience to automatically share context.

❗️ There should never be commits without a ticket referenced.

Merge Requests

Recommendation:

When creating a Gitlab merge request, use this formula:

fix/feat/bug(<jira-issue-name-list>): description of the change

Example:

fix(INFRA-163): Preventing multiple runs of a single CI/CD job

For commits, you can utilise the Semantic Release process to populate the change log for you by following the same process:

Recommendation:

fix/feat/bug(<issue_name>): Description of the change

For example:

fix(INFRA-169): Updating Docker image to use a bug fixed curl image, updating Docker tag elsewhere

We have a two way connection between both tools, meaning you can visualise what's changed. You can find this on the Jira issue itself.